/*******************************************************************************
* Copyright (c) 2000, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jdt.internal.corext.template.java;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.templates.GlobalTemplateVariables;
import org.eclipse.jface.text.templates.SimpleTemplateVariableResolver;
import org.eclipse.jface.text.templates.TemplateContext;
import org.eclipse.jface.text.templates.TemplateContextType;
import org.eclipse.jface.text.templates.TemplateException;
import org.eclipse.jface.text.templates.TemplateVariable;
import org.eclipse.jface.text.templates.TemplateVariableResolver;
import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IMethod;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.core.Signature;
import org.eclipse.jdt.ui.JavaElementLabels;
/**
* Compilation unit context type.
*/
public abstract class CompilationUnitContextType extends TemplateContextType {
protected static class ReturnType extends TemplateVariableResolver {
public ReturnType() {
super("return_type", JavaTemplateMessages.CompilationUnitContextType_variable_description_return_type); //$NON-NLS-1$
}
@Override
protected String resolve(TemplateContext context) {
IJavaElement element= ((CompilationUnitContext) context).findEnclosingElement(IJavaElement.METHOD);
if (element == null)
return null;
try {
return Signature.toString(((IMethod) element).getReturnType());
} catch (JavaModelException e) {
return null;
}
}
}
protected static class File extends TemplateVariableResolver {
public File() {
super("file", JavaTemplateMessages.CompilationUnitContextType_variable_description_file); //$NON-NLS-1$
}
@Override
protected String resolve(TemplateContext context) {
ICompilationUnit unit= ((CompilationUnitContext) context).getCompilationUnit();
return (unit == null) ? null : unit.getElementName();
}
/*
* @see org.eclipse.jface.text.templates.TemplateVariableResolver#isUnambiguous(org.eclipse.jface.text.templates.TemplateContext)
*/
@Override
protected boolean isUnambiguous(TemplateContext context) {
return resolve(context) != null;
}
}
protected static class PrimaryTypeName extends TemplateVariableResolver {
public PrimaryTypeName() {
super("primary_type_name", JavaTemplateMessages.CompilationUnitContextType_variable_description_primary_type_name); //$NON-NLS-1$
}
@Override
protected String resolve(TemplateContext context) {
ICompilationUnit unit= ((CompilationUnitContext) context).getCompilationUnit();
if (unit == null)
return null;
return JavaCore.removeJavaLikeExtension(unit.getElementName());
}
/*
* @see org.eclipse.jface.text.templates.TemplateVariableResolver#isUnambiguous(org.eclipse.jface.text.templates.TemplateContext)
*/
@Override
protected boolean isUnambiguous(TemplateContext context) {
return resolve(context) != null;
}
}
protected static class EnclosingJavaElement extends TemplateVariableResolver {
protected final int fElementType;
public EnclosingJavaElement(String name, String description, int elementType) {
super(name, description);
fElementType= elementType;
}
@Override
protected String resolve(TemplateContext context) {
IJavaElement element= ((CompilationUnitContext) context).findEnclosingElement(fElementType);
if (element instanceof IType)
return JavaElementLabels.getElementLabel(element, JavaElementLabels.T_CONTAINER_QUALIFIED);
return (element == null) ? null : element.getElementName();
}
/*
* @see org.eclipse.jface.text.templates.TemplateVariableResolver#isUnambiguous(org.eclipse.jface.text.templates.TemplateContext)
*/
@Override
protected boolean isUnambiguous(TemplateContext context) {
return resolve(context) != null;
}
}
protected static class Method extends EnclosingJavaElement {
public Method() {
super("enclosing_method", JavaTemplateMessages.CompilationUnitContextType_variable_description_enclosing_method, IJavaElement.METHOD); //$NON-NLS-1$
}
}
protected static class Type extends EnclosingJavaElement {
public Type() {
super("enclosing_type", JavaTemplateMessages.CompilationUnitContextType_variable_description_enclosing_type, IJavaElement.TYPE); //$NON-NLS-1$
}
}
/*
protected static class SuperClass extends EnclosingJavaElement {
public Type() {
super("super_class", TemplateMessages.getString("JavaContextType.variable.description.type"), IJavaElement.TYPE);
}
}
*/
protected static class Package extends EnclosingJavaElement {
public Package() {
super("enclosing_package", JavaTemplateMessages.CompilationUnitContextType_variable_description_enclosing_package, IJavaElement.PACKAGE_FRAGMENT); //$NON-NLS-1$
}
}
protected static class Project extends EnclosingJavaElement {
public Project() {
super("enclosing_project", JavaTemplateMessages.CompilationUnitContextType_variable_description_enclosing_project, IJavaElement.JAVA_PROJECT); //$NON-NLS-1$
}
}
/*
protected static class Project2 extends TemplateVariableResolver {
public Project2() {
super("project", TemplateMessages.getString("JavaContextType.variable.description.project"));
}
public String evaluate(TemplateContext context) {
ICompilationUnit unit= ((JavaContext) context).getUnit();
return (unit == null) ? null : unit.getJavaProject().getElementName();
}
}
*/
protected static class Arguments extends TemplateVariableResolver {
public Arguments() {
super("enclosing_method_arguments", JavaTemplateMessages.CompilationUnitContextType_variable_description_enclosing_method_arguments); //$NON-NLS-1$
}
@Override
protected String resolve(TemplateContext context) {
IJavaElement element= ((CompilationUnitContext) context).findEnclosingElement(IJavaElement.METHOD);
if (element == null)
return null;
IMethod method= (IMethod) element;
try {
String[] arguments= method.getParameterNames();
StringBuffer buffer= new StringBuffer();
for (int i= 0; i < arguments.length; i++) {
if (i > 0)
buffer.append(", "); //$NON-NLS-1$
buffer.append(arguments[i]);
}
return buffer.toString();
} catch (JavaModelException e) {
return null;
}
}
}
/*
protected static class Line extends TemplateVariableResolver {
public Line() {
super("line", TemplateMessages.getString("CompilationUnitContextType.variable.description.line"));
}
public String evaluate(TemplateContext context) {
return ((JavaTemplateContext) context).guessLineNumber();
}
}
*/
/**
* The line selection variable determines templates that work on selected
* lines.
* <p>
* This class contains additional description that tells about the
* 'Source > Surround With > ...' menu.</p>
*
* @since 3.7
* @see org.eclipse.jface.text.templates.GlobalTemplateVariables.LineSelection
*/
protected static class SurroundWithLineSelection extends SimpleTemplateVariableResolver {
/**
* Creates a new line selection variable
*/
public SurroundWithLineSelection() {
super(org.eclipse.jface.text.templates.GlobalTemplateVariables.LineSelection.NAME, JavaTemplateMessages.CompilationUnitContextType_variable_description_line_selection);
}
@Override
protected String resolve(TemplateContext context) {
String selection= context.getVariable(org.eclipse.jface.text.templates.GlobalTemplateVariables.SELECTION);
if (selection == null)
return ""; //$NON-NLS-1$
return selection;
}
}
/*
* @see ContextType#ContextType(String)
*/
public CompilationUnitContextType(String id) {
super(id);
}
public CompilationUnitContextType() {
}
public abstract CompilationUnitContext createContext(IDocument document, int completionPosition, int length, ICompilationUnit compilationUnit);
public abstract CompilationUnitContext createContext(IDocument document, Position completionPosition, ICompilationUnit compilationUnit);
/* (non-Javadoc)
* @see org.eclipse.jdt.internal.corext.template.ContextType#validateVariables(org.eclipse.jdt.internal.corext.template.TemplateVariable[])
*/
@Override
protected void validateVariables(TemplateVariable[] variables) throws TemplateException {
// check for multiple cursor variables
for (int i= 0; i < variables.length; i++) {
TemplateVariable var= variables[i];
if (var.getType().equals(GlobalTemplateVariables.Cursor.NAME)) {
if (var.getOffsets().length > 1) {
throw new TemplateException(JavaTemplateMessages.ContextType_error_multiple_cursor_variables);
}
}
}
}
}